home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pcbpc31.zip / PC.DOC < prev    next >
Text File  |  1991-03-15  |  17KB  |  379 lines
  1.                                   
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  12.  
  13.                         The Power Converter Version 3.0
  14.                         Copywright 1991 by PFG Software
  15.                        Copywright 1991 by John Schreiber
  16.  
  17. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  18.        PFG Software, 756 White Oak Rd., Falmouth, Va. 22405 (703)373-4915
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28. --- Warranty
  29.  
  30.    The Power Converter comes with no warranty expressed or implied. The user
  31. and the user alone is responsible for the use of this software. Neither John
  32. Schreiber nor PFG Software will be held responsible for any damage caused by
  33. this product.
  34.  
  35.  
  36. --- Upgrading from an earlier version.
  37.  
  38.    If you are upgrading for a earlier version of the converter, there are
  39.  some changes you'll need to make. FIrst rename your .KEY file to PC.KEY.
  40.  Secondly you'll have to redo your .DAT file and call it PC.DAT, additions
  41.  and changes have been made to this file. Lastly, set the enviroment variable
  42.  PFGERR equal to the path you would like your errors.pfg error log written.
  43.  I believe that should do you. Enjoy!
  44.  
  45. --- What is The Power Converter?
  46.  
  47.    The Power Converter is a door conversion utility that will convert your
  48.  BBSs system files into the proper file(s) to run several different types of
  49.  doors. The pride and joy of the Power Converter is it's accuracy. I went
  50.  through great pains to ensure that I used as little 'dummy' data as possible.
  51.  If the information was given to me, I used it. If I could deduce it from some
  52.  other pieces of data, I did so. All this means that you will notice far less
  53.  made up data on the status lines of your doors, thusly making your system more
  54.  informative for you the SysOp and making your doors run more smoothly for your
  55.  users. From this point on The Power Converter will be refered to as either
  56.  PC.EXE in it's executable form or The Power Converter. Now then let's get
  57.  on with telling you how to use the converter.
  58.  
  59.  
  60. --- Standard Features
  61.  
  62.    The Power Converter will convert your BBSs System files into the proper
  63.  files to run the following door types:
  64.  
  65.         AUNTIE BBS              denoted by     AUNTIE
  66.         DOORWAY                 denoted by     DOORWAY
  67.         EIS                     denoted by     EIS
  68.         FORCE                   denoted by     FORCE
  69.         GAP                     denoted by     GAP
  70.         GENESIS                 denoted by     GENESIS
  71.         Milton GameWorks        denoted by     MGW
  72.         OLECOM                  denoted by     OLECOM
  73.         PCBoard 12.1            denoted by     PCB12
  74.         PCBoard 14.1            denoted by     PCB14
  75.         PHOENIX                 denoted by     PHEONIX
  76.         PROKIT 3.0              denoted by     PCB14
  77.         PROKIT 3.1              denoted by     PCB14
  78.         QuickBBS                denoted by     QuickBBS
  79.         RBBS - PC 15.1          denoted by     RBBS15
  80.         RBBS - PC 16+           denoted by     RBBS16
  81.         RyBBS                   denoted by     RYBBS
  82.         SpitFire                denoted by     SPITFIRE
  83.         T.A.G BBS               denoted by     TAG
  84.         TP-Board                denoted by     TP-Board
  85.         Wildcat! 1.13           denoted by     WC
  86.         Wildcat! 2.0            denoted by     WC2
  87.         World War IV            denoted by     WWIV
  88.  
  89.  
  90.   In addition The Power Converter will create the following door-specific
  91.  (By door specific I mean files that only a certain door or group of
  92.  doors use. They are not creted or used by any Bulletin Board system.)
  93.  files:
  94.  
  95.  
  96.         Bit Bucket Software     denoted by     OPENDOOR
  97.         Operation Overkill II   denoted by     OO
  98.         Solar Realms Elite      denoted by     SRE
  99.  
  100.  
  101.  This is a list of what files each door conversion creates:
  102.  
  103.         AUNTIE                            Auntie.sys
  104.         DOORWAY                           Door.sys
  105.         EIS                               Dorinfox.def
  106.         FORCE                             Door.sys
  107.         GAP                               Door.sys
  108.         GENESIS                           Callinfo.bbs
  109.         Milton GameWorks                  Userinfo.txt
  110.         OLECOM                            Dorinfox.def
  111.         OPENDOOR                          Opendoor.sys
  112.         OPERATION OVERKILL II             Bbsinfo.oo
  113.         PCBoard 12.1                      PCBoard.sys, PCBoard.dat, Users
  114.         PCBoard 14.1                      PCBoard.sys, PCBoard.dat, Users
  115.         PHOENIX                           Info.bbs
  116.         PROKIT 3.0                        PCBoard.sys, PCBoard.dat, Users
  117.         PROKIT 3.1                        PCBoard.sys, PCBoard.dat, Users
  118.         QuickBBS                          Dorinfox.def
  119.         RBBS - PC 15.1                    Rbbs-pc.def, Messages, Dorinfox.def
  120.         RBBS - PC 16+                     Rbbs-pc.def, Messages, Dorinfox.def
  121.         RyBBS                             Curruser.bbs
  122.         SpitFire                          Sfdoors.dat
  123.         SRE                               Doorfile.sr
  124.         TAG                               Door.sys
  125.         TP-Board                          Dorinfox.def
  126.         Wildcat! 1.13                     Callinfo.bbs
  127.         Wildcat! 2.0                      Callinfo.bbs
  128.         WWIV                              Chain.txt
  129.  
  130.  
  131.      In order for The Power Converter to run properly, you will need to
  132.  have your BBS's system files and PC.DAT files all located in the same
  133.  directory.  The format of the PC.DAT file is as follows:
  134.  
  135.      Dr. Debug's Domain
  136.      Robert
  137.      York
  138.      COM1
  139.      19200
  140.      H
  141.      C:\BBS
  142.      DOOR.SYS
  143.  
  144.  
  145.       Line 1 -- The name of your BBS
  146.       Line 2 -- Your first name
  147.       Line 3 -- Your last name
  148.       Line 4 -- The comm port your BBS is using
  149.       Line 5 -- The locked baud rate of that port ( if none just leave blank)
  150.                 Note: If you are running a Locked Comm Port, you MUST set this
  151.                 line equal to that baud rate. If you do not your doors will
  152.                 not operate properly.)
  153.       Line 6 -- Hayes 9600, or Fastcomm 9600 ( H or F or blank if neither )
  154.       Line 7 -- Where you want your DOORWAY file written.
  155.       Line 8 -- The file type you want to use for DOORWAY. You have the
  156.                 choice of the following:
  157.  
  158.                         DOOR.SYS        - Gap style DOOR.SYS
  159.                         PCBOARD.SYS(12) - PCBoard v12 PCBOARD.SYS
  160.                         PCBOARD.SYS(14) - PCBoard v14 PCBOARD.SYS
  161.  
  162.                Both lines 7 & 8 are used by the converter when you call
  163.                for a DOORWAY conversion either normally or with an
  164.                advanced option to automatically detect both the path and
  165.                the file type you wish to use.
  166.  
  167.  
  168.    The next thing you wil have to do is set an environment variable
  169. called PFGERR equal to the path you want The Power Converter to write
  170. it's error log. You do so by editing your autoexec.bat file and adding
  171. a line like this:
  172.  
  173.     SET PFGERR=C:\GEN
  174.  
  175.    Where C:\GEN is the path you want to write the errors log file to. The
  176. log is called ERRORS.PFG, and it was added so that you didn't have to try
  177. to read the screen as an error scrolled by during batch file execution.
  178. It also allows you to keep an eye on your doors when you're not sitting there
  179. watching them. The environment variable was used because it was the only way
  180. I could be assured of having the path whenever I needed it during the execution
  181. of the code.
  182.  
  183.  
  184.   The Power Converter works from command line parameters as follows:
  185.  
  186.   The Power Converter <doortype> <path to data files> <path to write new files>
  187.   i.e.
  188.  
  189.   C:> PC.EXE GAP C:\GENESIS\ C:\GENESIS\DOORS\
  190.  
  191.    Where the doortype is any of the above listed door types. The
  192. path to data files is the location of your system files and the PC.DAT.
  193. The second path is where you want the files associated with the doortype to
  194. go. You may enter the command line in upper or lower case. The trailing
  195. backslash on the paths is optional.
  196.  
  197. You may omit both path statements provided the following conditions
  198. are met:
  199.  
  200.  1) ALL the data files are in the directory you are calling The Power Converter
  201.  from.
  202.  
  203.  2) You want all the files created by The Power Converter to go in the path you
  204.  call it from.
  205.  
  206.  3) You are not converting to either of the PCBoard or PROKIT formats.
  207.  The reason for this is that PROKIT and PCBoard doors are very touchy
  208.  about the data they are given in the PCBOARD files ( PCBOARD.SYS,
  209.  PCBOARD.DAT, and USERS) and require that the paths be given to them.
  210.  
  211.  
  212. NOTE: As of version 3.0, the second path is no longer optional if you wish
  213.       an output path specified. You may however skip the second path if you
  214.       want the files written to the directory you called the converter from.
  215.  
  216.  There is one command line delimeter that can be used with the
  217. Unregistered version of the converter it is as follows:
  218.  
  219.   -Nxx          This delimiter will allow you to specify the node the
  220.                 system wrote the file for. The xx can specify any number.
  221.                 This delimiter is primarily used with systems that write
  222.                 DORINFOx.DEF files.
  223.  
  224.  
  225. --- Registered Options
  226.  
  227.   With the release of version 3.0 of the Power Converter, I have changed
  228. the way I handle unregistered copies of the converter. Now instead of
  229. lowering the users time in the door to 10 minutes ( which was on the
  230. whole unfair to the users who weren't to pay for the converter anyway ),
  231. I have created and isolated a few extras for use with the converter.
  232. They do not diminish from the converters day to day use but when you
  233. register the converter they can enhance it's use.
  234.  
  235.   The first of the registered options handles the paths you use on the
  236. command line of the converter. For those sysops who always read their
  237. files from the same directory and/or always write them to the same
  238. directory, I have added support for environment variables to specify both
  239. the path to data files and the output path. For the path to data files,
  240. you should set the variable PFGIN to the path you used to specify on your
  241. command line. For the output path you should set PFGOUT to the path you
  242. used to write your files to. You can use either both of the variables or
  243. either one individually. The choice is yours.
  244.  
  245.  
  246.   Now is a good time to discuss the order the converter looks for variables
  247. in, and what it does when it finds conflicting commands. The converter
  248. first looks for the environment variables as a guide to where it should
  249. look for files and write it's conversions. If it finds them it will use
  250. them, if not it will look to the command line. You may however override
  251. the environment variables by specifying the paths on the command line.
  252. Any paths you issue the converter on the command line will automatically
  253. override the old paths set in the enviroment.
  254.  
  255.  So if you have the commands
  256.  
  257.          SET PFGIN=C:\BBS
  258.          SET PFGOUT=C:\BBS\DOORS
  259.  
  260. in your autoexec.bat file, the converter will use them, however if you
  261. enter a command line like this
  262.  
  263.          PC.EXE GAP C:\BBS C:\DOOR1
  264.  
  265. the converter will use the paths on the command line instead of the ones
  266. you issued in the environment.
  267.  
  268.  This is also a good time to discuss how the converter handles the
  269. command line parameters. The first undelimited( the delimited commands
  270. are shown below ) parameter the converter reads from the command
  271. line will always be thought of as the door type you want. The second
  272. will always be the path to your data files, and the third will always be
  273. the path you want the converter to write its files to. There are no
  274. exceptions to these rules.
  275.  
  276.  
  277.   -Txx          This delimiter allows you to lock the users time in the
  278.                 door to xx minutes. Again the xx can represent any number.
  279.  
  280.                 NOTE: Be selective when using this option on PROKIT doors.
  281.                       Prokit doors are designed to disconnect the user when
  282.                       his time runs out, so if you lock the users time to
  283.                       10 minutes when he has 30 minutes left on the system,
  284.                       a Prokit door will throw him offline when his 10
  285.                       minutes are up.
  286.  
  287.   -D            This delimiter is really a switch which tells the
  288.                 converter to write it's DOORWAY files in addition to it's
  289.                 already specified conversion.
  290.  
  291.   -A<door name> This delimiter is also really a switch. It tells the
  292.                 converter to log the door name you specify with the
  293.                 user's name, the time and date he entered the door, and
  294.                 hisr baud rate to a file. That file is readable by
  295.                 the included program called ACTIVITY, and will tell you
  296.                 who entered your doors when and will allow you to track
  297.                 how often your doors are used ( See the activity docs
  298.                 for more details ). The door name specified
  299.                 must be separated by a '_' if it's 2 words as shown
  300.                 below:
  301.  
  302.                 PC.EXE OO -AOPERATION_OVERKILL
  303.  
  304.  
  305.  When using a delimiter DO NOT separate the delimiter and its data by a
  306. space. That will cause a blank to be added to the beginning of the data
  307. and could cause problems for the converter.
  308.  
  309.   You may enter delimited parameters in any order you like because the
  310. converter uses the delimiters as a filter so it knows where to place
  311. each piece of data you give it. You may also use them with the
  312. undelimited parameters AS LONG AS you remember that the undelimited
  313. parameters must be entered in the order previously specified.
  314.  
  315.  One other option that has been added in this version of the converter
  316. is the ability for it to create any file it can create through a type
  317. conversion, individually. In other words if you have a door that only
  318. uses a PCBoard.sys file, the converter will now create just that file
  319. for you as opposed to your having to create all the files that a PCB12
  320. or PCB14 conversion will create. This should prove to be of great
  321. benefit to those of you running on a slower system ( like an XT ) and
  322. who want to optimize ( or minimize ) the drop time to a door. The
  323. following is a list of individual files The Power Converter will create
  324. for you:
  325.  
  326.       Auntie.sys            Auntie.bbs
  327.       Bbsinfo.oo            For Operatin Overkill
  328.       Callinfo.bbs          Genesis format Callinfo.bbs
  329.       Callinfo.bbs(WC113)   Wildcat! 1.13 format Callinfo.bbs
  330.       Callinfo.bbs(WC2)     Wildcat! 2.0 format Callinfo.bbs
  331.       Chain.txt             WWIV
  332.       Curruser.bbs          RyBBS
  333.       Door.sys              GAP format Door.sys
  334.       Dorinfox.def          RBBS-PC format dorinfox.def
  335.       Info.bbs              Phoenix BBS
  336.       Messages(15)          RBBS-PC v15 format Messages
  337.       Messages(16)          RBBS-PC v16 format Messages
  338.       PCBoard.sys(12)       PCBoard v12 PCBoard.sys
  339.       PCBoard.dat(12)       PCBoard v12 PCBoard.dat
  340.       PCBOard.sys(14)       PCBoard v14 PCBoard.sys
  341.       PCBoard.dat(14)       PCBoard v14 PCBoard.dat
  342.       RBBS-PC.def(15)       RBBS-PC v15 format RBBS-PC.def
  343.       RBBS-PC.def(16)       RBBS-PC v16 format RBBS-PC.def
  344.       Sfdoors.dat           Spitfire
  345.       Users(12)             PCBoard v12 format Users
  346.       Users(14)             PCBoard v14 format Users
  347.  
  348.  
  349. --- Registration
  350.  
  351.    In order to register The Power Converter you must fill out the registration
  352. form that is enclosed, and mail it to any of the appropriate support
  353. sites. They will , depending on the instructions you have given on the
  354. registration for either call you with or mail you, your registration
  355. code. Then all you need to do is type this at the command line:
  356.  
  357.    PC.EXE REGISTER
  358.  
  359. and the Power Converter will prompt you for the same information that
  360. you entered on your order form and for your registration code. IF you
  361. have entered all the info correctly, the program will alter your key and
  362. you will be a registered user.
  363.  
  364.  
  365. --- In Closing
  366.  
  367.    Enclosed you will now find a list of doors that have been brought to
  368. my attention as having bugs, and the solutions, if any, to the problems
  369. they have. The file is called DOORHELP.TXT. If you find any other doors
  370. that cause you problems please let me know and I can work with the
  371. authors to get the bugs ironed out of the doors.
  372.  
  373.    If you have any suggestions that you think will help make the
  374. converter better or easier to use let me know and I will be more than
  375. happy to implement them if at all possible.
  376.  
  377.    Thanks for your support!
  378.  
  379.